Package com.cisco.pt.ipc.ui.impl
Class PopupMenuImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.ui.impl.PopupMenuImpl
Information provided by the PKI file:
\class PopupMenu
\brief PopupMenu is the popup menu instantiated from the PopupMenuBar object.
\remark The built-in menus Activity Wizard, Multiuser, IPC, and the
seperator can only be manipulated by name. These menus will not provide
a UUID or PopupMenuItem class representation. Only items added via the IPC
have a UUID and are a derivative of the PopupMenuItem class.
\example appWindow().getPopupMenuBar().getFilePopupPopupMenu()
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionPopupMenuImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionintcount()Information provided by the PKI file:getPopupMenuItemAt(int index) Information provided by the PKI file:getPopupMenuItemByName(String name) Information provided by the PKI file:Information provided by the PKI file:getPopupMenuItemUuid(String name) Information provided by the PKI file:insertItem(String before, String action) Information provided by the PKI file:insertItemAfter(String after, String action) Information provided by the PKI file:insertItemWithName(String before, String action, String name) Information provided by the PKI file:insertItemWithNameAfter(String after, String action, String name) Information provided by the PKI file:insertSeparator(String before, String name) Information provided by the PKI file:insertSeparatorAfter(String after, String name) Information provided by the PKI file:voidremoveItem(String name) Information provided by the PKI file:voidremoveItemUuid(UUID id) Information provided by the PKI file:voidsetItemEnabled(String name, boolean bEnable) Information provided by the PKI file:voidsetItemEnabledUuid(UUID id, boolean bEnabled) Information provided by the PKI file:voidsetItemObjectEnabled(String name, boolean bEnable) Information provided by the PKI file:voidsetItemVisible(String name, boolean bVisible) Information provided by the PKI file:voidsetItemVisibleUuid(UUID id, boolean bVisible) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
PopupMenuImpl
public PopupMenuImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
count
public int count()Information provided by the PKI file:
\brief Returns the number of menu items in this menu. \return int, the number of menu items in this menu. -
getPopupMenuItemAt
Information provided by the PKI file:
\brief Returns the menu item at the specified index. \param index, the index of the menu item of interest. \return PopupMenuItem, the PopupMenuItem object at the specified index.- Specified by:
getPopupMenuItemAtin interfacePopupMenu- Parameters:
index- Takes in a parameter of index- Returns:
- PopupMenuItem Returns a PopupMenuItem
-
getPopupMenuItemByUuid
Information provided by the PKI file:
\brief Returns the menu item with the specified UUID. \param id, the UUID of the menu item of interest. \return PopupMenuItem, the PopupMenuItem object with the specified UUID.- Specified by:
getPopupMenuItemByUuidin interfacePopupMenu- Parameters:
id- Takes in a parameter of id- Returns:
- PopupMenuItem Returns a PopupMenuItem
-
getPopupMenuItemByName
Information provided by the PKI file:
\brief Returns the menu item with the specified name. \param name, the name of the menu item of interest. \return PopupMenuItem, the PopupMenuItem object with the specified name.- Specified by:
getPopupMenuItemByNamein interfacePopupMenu- Parameters:
name- Takes in a parameter of name- Returns:
- PopupMenuItem Returns a PopupMenuItem
-
getPopupMenuItemUuid
Information provided by the PKI file:
\brief Returns the UUID of the menu item with the specified name. \param name, the name of the menu item of interest. \return uuid, the UUID of the menu item with the specified name.- Specified by:
getPopupMenuItemUuidin interfacePopupMenu- Parameters:
name- Takes in a parameter of name- Returns:
- UUID Returns a UUID
-
setItemVisibleUuid
Information provided by the PKI file:
\brief Changes the visibility of the item with the specified UUID. \param id, the UUID of the menu item of interest. \param bVisibile, true to show the menu item, false to hide it.- Specified by:
setItemVisibleUuidin interfacePopupMenu- Parameters:
id- Takes in a parameter of idbVisible- Takes in a parameter of bVisible
-
setItemEnabledUuid
Information provided by the PKI file:
\brief Enables or disables input events to the menu item with the specified UUID. \param id, the UUID of the menu item of interest. \param bEnabled, true to enable input events to the menu item, false to disable it.- Specified by:
setItemEnabledUuidin interfacePopupMenu- Parameters:
id- Takes in a parameter of idbEnabled- Takes in a parameter of bEnabled
-
removeItemUuid
Information provided by the PKI file:
\brief Removes the menu item with the specified UUID. \param id, the UUID of the menu item of interest.- Specified by:
removeItemUuidin interfacePopupMenu- Parameters:
id- Takes in a parameter of id
-
insertItem
Information provided by the PKI file:
\brief Inserts an item before the specified item with the specified action. \param before, the name of the menu item to insert before. \param action, the action of the menu item. \return uuid, the UUID of the menu item that was inserted.- Specified by:
insertItemin interfacePopupMenu- Parameters:
before- Takes in a parameter of beforeaction- Takes in a parameter of action- Returns:
- UUID Returns a UUID
-
insertItemAfter
Information provided by the PKI file:
\brief Inserts an item after the specified item with the specified action. \param after, the name of the menu item to insert after. \param action, the action of the menu item. \return uuid, the UUID of the menu item that was inserted.- Specified by:
insertItemAfterin interfacePopupMenu- Parameters:
after- Takes in a parameter of afteraction- Takes in a parameter of action- Returns:
- UUID Returns a UUID
-
insertSeparator
Information provided by the PKI file:
\brief Inserts a separator before the specified item with the specified name. \param before, the name of the menu item to insert before. \param name, the name of the separator; not displayed but can be used to find it later. \return uuid, the UUID of the menu item that was inserted.- Specified by:
insertSeparatorin interfacePopupMenu- Parameters:
before- Takes in a parameter of beforename- Takes in a parameter of name- Returns:
- UUID Returns a UUID
-
insertSeparatorAfter
Information provided by the PKI file:
\brief Inserts a separator after the specified item with the specified name. \param after, the name of the menu item to insert after. \param name, the name of the separator; not displayed but can be used to find it later. \return uuid, the UUID of the menu item that was inserted.- Specified by:
insertSeparatorAfterin interfacePopupMenu- Parameters:
after- Takes in a parameter of aftername- Takes in a parameter of name- Returns:
- UUID Returns a UUID
-
removeItem
Information provided by the PKI file:
\brief Removes the specified menu item. \param name, the name of the menu item.- Specified by:
removeItemin interfacePopupMenu- Parameters:
name- Takes in a parameter of name
-
setItemVisible
Information provided by the PKI file:
\brief Shows or hides the specified menu item. \param name, the name of the menu item. \param bVisible, true to show the menu item, false to hide it.- Specified by:
setItemVisiblein interfacePopupMenu- Parameters:
name- Takes in a parameter of namebVisible- Takes in a parameter of bVisible
-
setItemEnabled
Information provided by the PKI file:
\brief Enables or disables the specified menu item. \param name, the name of the menu item. \param bEnable, true to enable the menu item, false to disable it.- Specified by:
setItemEnabledin interfacePopupMenu- Parameters:
name- Takes in a parameter of namebEnable- Takes in a parameter of bEnable
-
setItemObjectEnabled
Information provided by the PKI file:
\brief Enables or disables the specified menu item using object name. \param name, the name of the menu item. \param bEnable, true to enable the menu item, false to disable it.- Specified by:
setItemObjectEnabledin interfacePopupMenu- Parameters:
name- Takes in a parameter of namebEnable- Takes in a parameter of bEnable
-
insertItemWithName
Information provided by the PKI file:
\brief Inserts an item before the specified item with the specified action. \param before, the name of the menu item to insert before. \param action, the action of the menu item. \param name, object name assigned to the action \return uuid, the UUID of the menu item that was inserted.- Specified by:
insertItemWithNamein interfacePopupMenu- Parameters:
before- Takes in a parameter of beforeaction- Takes in a parameter of actionname- Takes in a parameter of name- Returns:
- UUID Returns a UUID
-
insertItemWithNameAfter
Information provided by the PKI file:
\brief Inserts an item after the specified item with the specified action. \param after, the name of the menu item to insert after. \param action, the action of the menu item. \param name, object name assigned to the action \return uuid, the UUID of the menu item that was inserted.- Specified by:
insertItemWithNameAfterin interfacePopupMenu- Parameters:
after- Takes in a parameter of afteraction- Takes in a parameter of actionname- Takes in a parameter of name- Returns:
- UUID Returns a UUID
-